<!-- HTML header for doxygen 1.8.12-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pymoduleconnector: pymoduleconnector.moduleconnectorwrapper.PreferredSplitSize Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
  <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    <!-- Platform title -->
    <div class="page-title-bar container-fluid">
      <div id="projectalign" class="row">
        <div id="projectname" class="col-sm-12">pymoduleconnector
          &#160;<span id="projectnumber">1.6.2</span>
        </div>
        <div id="projectbrief" class="col-sm-12">A Python wrapper for XeThru ModuleConnector</div>
      </div>
    </div>
    <div class="topbar">
      <div class="container">
        <div id="titlearea">
          <div class="xethru-logo">
            <img src="xethru-logo_220x55HD.png" alt="Novelda XeThru web site" id="logo-image" />
          </div>
        </div>
        <!-- end header part -->
        <!-- Generated by Doxygen 1.8.12 -->
        <!--BEGIN MAIN-NAV AND SEARCHENGINE-->
        <div id="main-nav"></div>
        <!--END MAIN-NAV AND SEARCHENGINE-->
      </div>
    </div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>pymoduleconnector</b></li><li class="navelem"><b>moduleconnectorwrapper</b></li><li class="navelem"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml">PreferredSplitSize</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size-members.xhtml">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">pymoduleconnector.moduleconnectorwrapper.PreferredSplitSize Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml" title="The PreferredSplitSize class allows specifying a split size. ">PreferredSplitSize</a> class allows specifying a split size.  
 <a href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3ad8fcee41182b954cac63205cbd9680"><td class="memItemLeft" align="right" valign="top"><a id="a3ad8fcee41182b954cac63205cbd9680"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, args)</td></tr>
<tr class="separator:a3ad8fcee41182b954cac63205cbd9680"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3650d9e6a9a6ec1ed93256c16836ee46"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml#a3650d9e6a9a6ec1ed93256c16836ee46">get_duration</a> (self)</td></tr>
<tr class="memdesc:a3650d9e6a9a6ec1ed93256c16836ee46"><td class="mdescLeft">&#160;</td><td class="mdescRight">get_duration(PreferredSplitSize self) -&gt; int  <a href="#a3650d9e6a9a6ec1ed93256c16836ee46">More...</a><br /></td></tr>
<tr class="separator:a3650d9e6a9a6ec1ed93256c16836ee46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c0621ca2405a4692979fe4f9d648b8a"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml#a3c0621ca2405a4692979fe4f9d648b8a">set_duration</a> (self, seconds)</td></tr>
<tr class="memdesc:a3c0621ca2405a4692979fe4f9d648b8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">set_duration(PreferredSplitSize self, int seconds)  <a href="#a3c0621ca2405a4692979fe4f9d648b8a">More...</a><br /></td></tr>
<tr class="separator:a3c0621ca2405a4692979fe4f9d648b8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a446b1354dfd6752be8ee76bf61dea175"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml#a446b1354dfd6752be8ee76bf61dea175">get_byte_count</a> (self)</td></tr>
<tr class="memdesc:a446b1354dfd6752be8ee76bf61dea175"><td class="mdescLeft">&#160;</td><td class="mdescRight">get_byte_count(PreferredSplitSize self) -&gt; int64_t  <a href="#a446b1354dfd6752be8ee76bf61dea175">More...</a><br /></td></tr>
<tr class="separator:a446b1354dfd6752be8ee76bf61dea175"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1cba62a0415affe89efab0a2cedfa6f"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml#ac1cba62a0415affe89efab0a2cedfa6f">set_byte_count</a> (self, count)</td></tr>
<tr class="memdesc:ac1cba62a0415affe89efab0a2cedfa6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">set_byte_count(PreferredSplitSize self, int64_t count)  <a href="#ac1cba62a0415affe89efab0a2cedfa6f">More...</a><br /></td></tr>
<tr class="separator:ac1cba62a0415affe89efab0a2cedfa6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a174f06b3429cb542bff5ecc4187db8cb"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml#a174f06b3429cb542bff5ecc4187db8cb">get_fixed_daily_hour</a> (self)</td></tr>
<tr class="memdesc:a174f06b3429cb542bff5ecc4187db8cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">get_fixed_daily_hour(PreferredSplitSize self) -&gt; int  <a href="#a174f06b3429cb542bff5ecc4187db8cb">More...</a><br /></td></tr>
<tr class="separator:a174f06b3429cb542bff5ecc4187db8cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad4268835a259e9f88617dad82464159"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml#aad4268835a259e9f88617dad82464159">set_fixed_daily_hour</a> (self, hour)</td></tr>
<tr class="memdesc:aad4268835a259e9f88617dad82464159"><td class="mdescLeft">&#160;</td><td class="mdescRight">set_fixed_daily_hour(PreferredSplitSize self, int hour)  <a href="#aad4268835a259e9f88617dad82464159">More...</a><br /></td></tr>
<tr class="separator:aad4268835a259e9f88617dad82464159"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b9d603ab5ae8fa32a5ac826a5babb89"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml#a4b9d603ab5ae8fa32a5ac826a5babb89">get_type</a> (self)</td></tr>
<tr class="memdesc:a4b9d603ab5ae8fa32a5ac826a5babb89"><td class="mdescLeft">&#160;</td><td class="mdescRight">get_type(PreferredSplitSize self) -&gt; XeThru::PreferredSplitSize::SizeType  <a href="#a4b9d603ab5ae8fa32a5ac826a5babb89">More...</a><br /></td></tr>
<tr class="separator:a4b9d603ab5ae8fa32a5ac826a5babb89"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a3c2f81b016f520baee5e5526b89d2cfb"><td class="memItemLeft" align="right" valign="top"><a id="a3c2f81b016f520baee5e5526b89d2cfb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>this</b></td></tr>
<tr class="separator:a3c2f81b016f520baee5e5526b89d2cfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a7ebe9842458897b4892a0030798df24d"><td class="memItemLeft" align="right" valign="top"><a id="a7ebe9842458897b4892a0030798df24d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DurationType</b> = _moduleconnectorwrapper.PreferredSplitSize_DurationType</td></tr>
<tr class="separator:a7ebe9842458897b4892a0030798df24d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b38224288886ccefcdbec81de2aa095"><td class="memItemLeft" align="right" valign="top"><a id="a8b38224288886ccefcdbec81de2aa095"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ByteCountType</b> = _moduleconnectorwrapper.PreferredSplitSize_ByteCountType</td></tr>
<tr class="separator:a8b38224288886ccefcdbec81de2aa095"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a893944cdf1a7fe291319bb5167cab983"><td class="memItemLeft" align="right" valign="top"><a id="a893944cdf1a7fe291319bb5167cab983"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FixedDailyHour</b> = _moduleconnectorwrapper.PreferredSplitSize_FixedDailyHour</td></tr>
<tr class="separator:a893944cdf1a7fe291319bb5167cab983"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e1a16bc1b622b956bfee434ef89135e"><td class="memItemLeft" align="right" valign="top"><a id="a0e1a16bc1b622b956bfee434ef89135e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>InvalidType</b> = _moduleconnectorwrapper.PreferredSplitSize_InvalidType</td></tr>
<tr class="separator:a0e1a16bc1b622b956bfee434ef89135e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml" title="The PreferredSplitSize class allows specifying a split size. ">PreferredSplitSize</a> class allows specifying a split size. </p>
<p>The <a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_preferred_split_size.xhtml" title="The PreferredSplitSize class allows specifying a split size. ">PreferredSplitSize</a> class contains functions to define a preferred split size for files and directories specified in either duration (seconds) or as number of bytes. Specifying both is not supported; the last specified type will rule.</p>
<dl class="section note"><dt>Note</dt><dd>As the class name indicates, the size is only a <em>preferred</em> size. There is no guarantee that the actual size will match 100%.</dd></dl>
<p>See DataRecorder, <a class="el" href="classpymoduleconnector_1_1moduleconnectorwrapper_1_1_recording_options.xhtml" title="The RecordingOptions class allows specifying options for recording. ">RecordingOptions</a></p>
<p>C++ includes: PreferredSplitSize.hpp </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a446b1354dfd6752be8ee76bf61dea175"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a446b1354dfd6752be8ee76bf61dea175">&sect;&nbsp;</a></span>get_byte_count()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.PreferredSplitSize.get_byte_count </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>get_byte_count(PreferredSplitSize self) -&gt; int64_t </p>
<h2>Returns </h2>
<p>the preferred file size as number of bytes if set, otherwise -1. </p>

</div>
</div>
<a id="a3650d9e6a9a6ec1ed93256c16836ee46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3650d9e6a9a6ec1ed93256c16836ee46">&sect;&nbsp;</a></span>get_duration()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.PreferredSplitSize.get_duration </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>get_duration(PreferredSplitSize self) -&gt; int </p>
<h2>Returns </h2>
<p>the preferred split size in seconds if set, otherwise -1. </p>

</div>
</div>
<a id="a174f06b3429cb542bff5ecc4187db8cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a174f06b3429cb542bff5ecc4187db8cb">&sect;&nbsp;</a></span>get_fixed_daily_hour()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.PreferredSplitSize.get_fixed_daily_hour </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>get_fixed_daily_hour(PreferredSplitSize self) -&gt; int </p>
<h2>Returns </h2>
<p>the fixed daily hour if set (0-23), otherwise returns -1. </p>

</div>
</div>
<a id="a4b9d603ab5ae8fa32a5ac826a5babb89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b9d603ab5ae8fa32a5ac826a5babb89">&sect;&nbsp;</a></span>get_type()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.PreferredSplitSize.get_type </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>get_type(PreferredSplitSize self) -&gt; XeThru::PreferredSplitSize::SizeType </p>
<p>The value reflects the last specified type, e.g.</p>
<p>if calling set_duration(15 * 60) this function returns DurationType.</p>
<h2>Returns </h2>
<p>the type of the preferred size.</p>
<p>See SizeType </p>

</div>
</div>
<a id="ac1cba62a0415affe89efab0a2cedfa6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1cba62a0415affe89efab0a2cedfa6f">&sect;&nbsp;</a></span>set_byte_count()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.PreferredSplitSize.set_byte_count </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>set_byte_count(PreferredSplitSize self, int64_t count) </p>
<p>Sets the preferred split size specified as number of bytes.</p>
<h2>Parameters </h2>
<ul>
<li><code>count</code> : </li>
</ul>

</div>
</div>
<a id="a3c0621ca2405a4692979fe4f9d648b8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c0621ca2405a4692979fe4f9d648b8a">&sect;&nbsp;</a></span>set_duration()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.PreferredSplitSize.set_duration </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>seconds</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>set_duration(PreferredSplitSize self, int seconds) </p>
<p>Sets the preferred split size specified in seconds.</p>
<h2>Parameters </h2>
<ul>
<li><code>seconds</code> : </li>
</ul>

</div>
</div>
<a id="aad4268835a259e9f88617dad82464159"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad4268835a259e9f88617dad82464159">&sect;&nbsp;</a></span>set_fixed_daily_hour()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.moduleconnectorwrapper.PreferredSplitSize.set_fixed_daily_hour </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>hour</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>set_fixed_daily_hour(PreferredSplitSize self, int hour) </p>
<p>Sets the preferred split size to a fixed daily hour.</p>
<p>Range is 24 hour clock (0-23). For example, if splitting every day at 2pm is desired, the parameter to this function would be 14. By default, no fixed daily hour is set.</p>
<h2>Parameters </h2>
<ul>
<li><code>hour</code> : </li>
</ul>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>pymoduleconnector/moduleconnectorwrapper/__init__.py</li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.12-->
<!-- start footer part -->
<hr class="footer"/>
 <address class="footer">
 Copyright &copy; 2016 Novelda AS - <a href="http://www.xethru.com">www.xehtru.com</a><br />
 <small>
  Generated by &#160;<a href="http://www.doxygen.org/index.html">
  <img class="footer" src="doxygen.png" alt="doxygen"/>
  </a> 1.8.12
 </small>
 </address>
</body>
</html>
